#pragma once
//-------------------------------------------------------------------------------------------------
//IImageProcStep.h  - Interface for Image Processing Step (function)          
//-------------------------------------------------------------------------------------------------
//FreeBSD License
//Copyright 2012 Will Stott All rights reserved.
//
//Redistribution and use in source and binary forms, with or without modification, are
//permitted provided that the following conditions are met:
//
//   1. Redistributions of source code must retain the above copyright notice, this list of
//      conditions and the following disclaimer.
//
//   2. Redistributions in binary form must reproduce the above copyright notice, this list
//      of conditions and the following disclaimer in the documentation and/or other materials
//      provided with the distribution.
//
//THIS SOFTWARE IS PROVIDED BY Will Stott ``AS IS'' AND ANY EXPRESS OR IMPLIED
//WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
//FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Will Stott OR
//CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
//ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
//NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//The views and conclusions contained in the software and documentation are those of the
//authors and should not be interpreted as representing official policies, either expressed
//or implied, of Will Stott.
//
//----Authors--------------------------------------------------------------------------------------
//created by: will.stott@ucl.ac.uk Feb 2012
//
//----Comments-------------------------------------------------------------------------------------
//
//		Derive a class for all your Image Processing Steps from IImageProcStepLibDyn, say ImageProcDummyLib - this provides an Api for the Library
//		Derive a class for executing an Image Processing Step from IImageProcStep, say CImageProcDummy - this is executed as a Thread
//		Derive a class for each Image Processing Step from ImageProcFunctionInterface, say DummyTwo - this is called from the Thread to do the real work
//		
//		class ImageProc
//		{
//			MyImageStepLib *_lib;
//			ProcParamsInputs *_input;
//			ProcParamsOutputs *_output;
//
//			DoInit()
//			{
//				_lib = new MyImageStepLib(xmlElement);						//creates a collection of steps from IEF-XML and checks each step IsValid()
//				
//				for (int x = 0, ImageProcStep *procstep = '\0'; x < _lib->GetStepCnt(); procstep = _lib->GetProcStep(x) )
//				{
//					if (procstep->IsValid(_lib->GetLibApi()) == false)		//checks that the function name for procstep exists in MyImageStepLib and its associated parameters are correct - i.e. ProcDef->IsInputParamValid(ProcStep->getInputParams()), ...
//						abort(procstep);
//				}
//			}
//
//			DoRunExpt()
//			{
//				_step = _lib->GetFirstStep();								//automatically creates a thread to execute an image processing step
//
//				_input = new ProcParamsInputs(_step->GetInputs())
//				_output = new ProcParamsOutputs(_step->GetOutputs())
//				_step->Setup("CalcAvBrightness", output, input);			//starts  step->Process(cnt) before returning, _step->IsDone() is false until thread has finished its work
//			}
//
//			DoTimer()
//			{
//				if (_step != '\0')
//				{
//					if (_step->IsDone() )
//					{
//						SaveStep(_step);									//copy step to some form of list to allow examination after expt
//						delete _step;
//						_step = _lib->GetNextStep();
//					}
//				}
//			}
//		}
//-------------------------------------------------------------------------------------------------
//#ifdef IMAGEEXPTLIB_EXPORTS
//#define IMAGEEXPTLIBAPI __declspec(dllexport)
//#else
//#define IMAGEEXPTLIBAPI __declspec(dllimport)
//#endif

class ProcParamsOutputs;
class ProcParamsInputs;

//class IMAGEEXPTLIBAPI IImageProcStep
class IImageProcStep
{
public:
	virtual void	Setup(const char *FunctionName, ProcParamsOutputs *output, ProcParamsInputs *input) = 0;
	virtual bool	IsDone() = 0;

};

//-------------------------------------------------------------------------------------------------
//			E N D   O F   F I L E
//-------------------------------------------------------------------------------------------------

